home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / XRefGED20API.readme < prev   
Encoding:
Text File  |  1995-04-27  |  4.3 KB  |  103 lines
  1. Short:    GoldED2.0 API Client for the XRef-System xref_v1.1.lha
  2. Author:   ruppert@vs3.informatik.fh-wiesbaden.de
  3. Uploader: ruppert@vs3.informatik.fh-wiesbaden.de
  4. Type:     dev/misc
  5.  
  6.  
  7. NAME
  8.     XRefAPI - GoldED API client for use with the xref.library to complete
  9.               phrases
  10.  
  11. FUNCTION
  12.     Just run GoldED and load this as an API-Client ! Then you have the
  13.     following new ARexx command :
  14.  
  15. TEMPLATE
  16.     XREFPHRASE CATEGORY/K,TYPES/K,MATCH/K,COMPLETEBEGIN/S,UPPERCASE/S,
  17.                SPACE/S
  18.  
  19. FORMAT
  20.     XREFPHRASE [CATEGORY <string|pattern>] [TYPES <to search for>]
  21.                [MATCH matchmode] [COMPLETEBEGIN] [UPPERCASE] [SPACE]
  22.  
  23.  
  24.  
  25. FUNCTION
  26.     the XREFPHRASE command tries to complete the current pharse (before 
  27.     the cursor) with the entries from the xref.library. This is done by
  28.     two algorithms :
  29.         - First uppercase letter match :
  30.             This means each character in the phrase must match the
  31.             next uppercase letter in the name ! For example :
  32.             the pharse "ow" matches "OpenWindow()" ("O"pen"W"indow())
  33.         - Second begin match :
  34.             The entry must match the beginning of the phrase !
  35.     There is a automatic two switch between to algorithms :
  36.         - if the pharse consists only of lower case letters the
  37.           uppercase letter match algorithm is used !
  38.         - if in the pharse is a uppercase letter the begin match
  39.           algorithm is used !
  40.     Note the matchmode RECURSIVE uses only the begin match algorithm !
  41.  
  42. INPUTS
  43.     CATEGORY (STRING) - category string|pattern to search in
  44.  
  45.     TYPES (STRING) - types, which would only match ("function","struct",
  46.         "function|struct" or so on)
  47.  
  48.     MATCH (STRING) - one of the following three matchmode strings 
  49.         (default is FIRST) :
  50.         FIRST - always get the first entry, which match the given pharse
  51.         RECURSIVE - much like a Tab-Completion algorithm, it search for
  52.             all entries matches the given phrase and complete it to the
  53.             last character equal to all entries ! If you pass UPPERCASE
  54.             argument the search is case-insenitive !
  55.             If you pass the phrase you passed last and cannot be more
  56.             completed, it switches to the SELECT matchmode and displays
  57.             the window !
  58.             This mode uses everytime the begin match algorithm !!!
  59.         SELECT - it searchs for all entries matching the given phrase and
  60.             if more than one is found, it opens a window you can select
  61.             one !
  62.  
  63.     COMPLETEBEGIN (BOOLEAN) - use the begin match algorithm instead of
  64.         uppercase letter match !
  65.  
  66.     UPPERCASE (BOOLEAN) - convert the phrase to upper
  67.  
  68.     SPACE (BOOLEAN) - if a name is found and inserted place a space behind
  69.  
  70. RESULTS
  71.     the command returns RC_OK, if it could complete the pharse. RC_WARN
  72.     if not !
  73.  
  74. EXAMPLE
  75.     'XREFPHRASE CATEGORY #?AutoDoc TYPES "function"' :
  76.  
  77.     This command will parse all AutoDoc categories and compare the given
  78.     shortcut with any function found in the xreffiles.For example the two
  79.     letters "ow" will completed to "OpenWindow(", if you have the
  80.     sys_autodoc.xref installed from the XRef-System package !
  81.  
  82. SEE ALSO
  83.     XRef-System.guide, GoldED/API, xref.library/ParseXRef(), ParseXRef
  84.  
  85.  
  86. ============================= Archive contents =============================
  87.  
  88. Original  Packed Ratio    Date     Time    Name
  89. -------- ------- ----- --------- --------  -------------
  90.     3186    1321 58.5% 05-Apr-95 22:49:04  XRef/Doc/english/XRefAPI.doc
  91.      468     232 50.4% 13-Sep-94 17:29:02  XRef/Doc/english/XRefAPI.doc.info
  92.     3582    1472 58.9% 05-Apr-95 22:49:20  XRef/Help/english/XRefAPI.guide
  93.      464     214 53.8% 13-Sep-94 17:29:14  XRef/Help/english/XRefAPI.guide.info
  94.       48      48  0.0% 02-Apr-95 23:32:12  XRef/Tools/golded/project
  95.     1377     698 49.3% 05-Apr-95 22:47:46  XRef/Tools/golded/SMakeFile
  96.      853     483 43.3% 13-Sep-94 17:30:10  XRef/Tools/golded/SMakeFile.info
  97.     7996    5111 36.0% 05-Apr-95 22:43:18  XRef/Tools/golded/XRefAPI
  98.    31937    8438 73.5% 05-Apr-95 22:48:58  XRef/Tools/golded/XRefAPI.c
  99.      417     214 48.6% 13-Sep-94 17:30:10  XRef/Tools/golded/XRefAPI.c.info
  100.      834     378 54.6% 13-Sep-94 17:30:10  XRef/Tools/golded/XRefAPI.info
  101. -------- ------- ----- --------- --------
  102.    51162   18609 63.6% 11-Apr-95 10:19:08   11 files
  103.